home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1991 …esperately Seeking Seven / Desperately Seeking Seven.2mg / Dev.CD.8 / Essentials / Tools / File.Type.Notes / FTN.1A.XXXX < prev    next >
Encoding:
Text File  |  1989-08-04  |  13.5 KB  |  309 lines  |  [04] ASCII Text (0x0000)

  1. Apple II
  2. File Type Notes
  3. _____________________________________________________________________________
  4.                                                   Developer Technical Support
  5.  
  6.  
  7. File Type:         $1A (26)
  8. Auxiliary Type:    All
  9.  
  10. Full Name:     AppleWorks Word Processor File
  11. Short Name:    AppleWorks WP File
  12.  
  13. Revised by:    Matt Deatherage & John Kinder, CLARIS Corp.     September 1989
  14. Written by:    Bob Lissner    February 1984
  15.  
  16. Files of this type and auxiliary type contain an AppleWorks(R) Word Processor 
  17. file.
  18. Changes since May 1989:  Updated to include AppleWorks 2.1 and AppleWorks 
  19. 3.0.
  20. _____________________________________________________________________________
  21.  
  22. Files of type $1A and any auxiliary type contain an AppleWorks Word Processor 
  23. file.  AppleWorks is published by CLARIS.  CLARIS also has additional 
  24. information on AppleWorks files SEG.PR and SEG.ER.  For information on 
  25. AppleWorks, contact CLARIS at:
  26.  
  27.                     CLARIS Corporation
  28.                     5201 Patrick Henry Drive
  29.                     P.O. Box 58168
  30.                     Santa Clara, CA 95052-8168
  31.  
  32.                     Technical Support
  33.                     Telephone:  (408) 727-9054
  34.                     AppleLink:  Claris.Tech
  35.  
  36.                     Customer Relations
  37.                     Telephone:  (408) 727-8227
  38.                     AppleLink:  Claris.CR
  39.  
  40. AppleWorks was created by Bob Lissner.  AppleWorks 2.1 was done by Bob Lissner 
  41. and John Kinder of CLARIS.  AppleWorks 3.0 was done by Alan Bird, Rob Renstrom 
  42. and Randy Brandt of Beagle Bros Software with John Kinder of CLARIS.
  43.  
  44.  
  45. Definitions
  46.  
  47. The following definitions apply to AppleWorks files in addition to those 
  48. defined for all Apple II file types:
  49.  
  50.     MRL    Data base multiple record layout
  51.     SRL    Data base single record layout
  52.     RAC    Review/Add/Change screen
  53.     DB     AppleWorks or /// E-Z Pieces Data Base
  54.     SS     AppleWorks or /// E-Z Pieces Spreadsheet
  55.     WP     AppleWorks or /// E-Z Pieces Word Processor
  56.     AW     AppleWorks or /// E-Z Pieces
  57.  
  58.  
  59. Auxiliary Type Definitions
  60.  
  61. The volume or subdirectory auxiliary type word for this file type is defined 
  62. to control uppercase and lowercase display of filenames.  The highest bit of 
  63. the least significant byte corresponds to the first character of the filename, 
  64. the next highest bit of the least significant byte corresponds to the second 
  65. character, etc., through the second bit of the most significant byte, which 
  66. corresponds to the fifteenth character of the filename.
  67.  
  68. AppleWorks performs the following steps when it saves a file to disk:
  69.  
  70.   1.  Zeros all 16 bits of the auxiliary type word.
  71.   2.  Examines the filename for lowercase letters.  If one is found, it 
  72.       changes the corresponding bit in the auxiliary type word to 1 and 
  73.       changes the letter to uppercase.
  74.   3.  Examines the filename for spaces.  If one is found, it changes the 
  75.       corresponding bit in the auxiliary type word to 1 and changes the 
  76.       space to a period.
  77.  
  78. When files are read from disk, the filename and auxiliary type information 
  79. from the directory file entry are used to determine which characters should be 
  80. lowercase and which periods should be displayed as spaces.  If you use the 
  81. auxiliary type bytes for a different purpose, AppleWorks will still display 
  82. the filenames, but the wrong letters are likely lowercase.
  83.  
  84.  
  85. File Version Changes
  86.  
  87. Certain features present in AppleWorks 3.0 files are not backward-compatible 
  88. to 2.1 and earlier versions.  Such features are noted in the text.  AppleWorks 
  89. Word Processor files which may not be loaded by versions prior to 3.0 are 
  90. identified by a non-zero byte at location +183, referred to as location 
  91. SFMinVers.
  92.  
  93. Those features added for AppleWorks 2.0, 2.1 and 3.0 not previously documented 
  94. are indicated with that version number in the margin.
  95.  
  96.  
  97. Word Processor Files
  98.  
  99. Word Processor files start with a 300 byte header, followed by a number of 
  100. variable length line records, one for each line on the screen.
  101.  
  102. Header Record
  103.  
  104. The header contains the following information:
  105.  
  106. +000 to +003                Not used.
  107. +004               Byte     $4F (79)
  108. +005 to +084       Bytes    Tab stops.  Either equal sign (=) or 
  109.                             vertical bar (|)  If SFMinVers is non-
  110.                             zero, these will be one of the following 
  111.                             values:
  112.                             "=" - no tab
  113.                             "<" - left tab
  114.                             "^" - center tab
  115.                             ">" - right tab
  116.                             "." - decimal tab.
  117. +085               Byte     Boolean:  Zoom switch.
  118. +086 to +089                Four bytes not used.
  119. +090               Byte     Boolean:  Whether file is currently 
  120.                             paginated (i.e., whether the page break 
  121.                             lines are displayed).
  122. +091               Byte     Minimum left margin that should be added 
  123.                             to the margin that is appearing on the 
  124.                             screen.  This is normally one inch, shown 
  125.                             in 10ths of an inch, 10 or $0A.
  126. +092               Byte     Boolean:  Whether file contains any mail-
  127.                             merge commands.
  128. +093 to +175       Bytes    Not used.  Reserved.
  129. 3.0 +176           Byte     Boolean:  Whether there are multiple 
  130.                             rulers in the document.
  131. 3.0 +177 to +182   Bytes    Used internally for keeping track of tab 
  132.                             rulers.
  133. 3.0 +183           Byte     SFMinVers.  The minimum version of 
  134.                             AppleWorks needed to read this document.  
  135.                             If this document contains 3.0 specific 
  136.                             features (tabs and multiple tab rulers, 
  137.                             for example), this byte will contain the 
  138.                             version number 30 ($1E).  Otherwise, it 
  139.                             will be zero ($00).
  140. +184 to +249       Bytes    Reserved.
  141. +250 to +299       Bytes    Available.  Will never be used by 
  142.                             AppleWorks.  If you are creating this type 
  143.                             of file, you can use this area to keep 
  144.                             information that is important to your 
  145.                             program.
  146.  
  147. Line Records
  148.  
  149. Line records are of three different types.  The first line record after the 
  150. 300 byte header corresponds to line 1, the next is line 2, and so on.  The 
  151. first two bytes of each line record contain enough information to establish 
  152. the type.
  153.  
  154. If SFMinVers is non-zero, the first line record (two bytes long) is invalid 
  155. and should be skipped.
  156.  
  157. Carriage Return Line Records
  158.  
  159. Carriage return line records have a $D0 (208) in byte +001.  Byte +000 is a 
  160. one byte integer between 00 and 79 that is the horizontal screen position of 
  161. this carriage return.
  162.  
  163. Command Line Records
  164.  
  165. Command line records are formatting commands that appear on the screen in the 
  166. form:
  167.  
  168. --------Double Space
  169.  
  170. for example.  These records can be identified by a value greater than $D0 
  171. (208) in byte +001. They are:
  172.  
  173.        Byte +001    Command            Byte +000
  174.        ______________________________________________________________________
  175. 3.0    $D4          reserved           (used internally as ruler)
  176. 3.0    $D5          Page header end    
  177. 3.0    $D6          Page footer end
  178. 3.0    $D7          Right justified
  179.        $D8          Platen width       Byte  10ths of an inch
  180.        $D9          Left margin        Byte  10ths of an inch
  181.        $DA          Right margin       Byte  10ths of an inch
  182.        $DB          Chars per inch     Byte
  183.        $DC          Proportional-1           No meaning
  184.        $DD          Proportional-2
  185.        $DE          Indent             Byte  Characters
  186.        $DF          Justify
  187.        $E0          Unjustify
  188.        $E1          Center
  189.        $E2          Paper length       Byte  10ths of an inch
  190.        $E3          Top margin         Byte  10ths of an inch
  191.        $E4          Bottom margin      Byte  10ths of an inch
  192.        $E5          Lines per inch     Byte
  193.        $E6          Single space
  194.        $E7          Double space
  195.        $E8          Triple space
  196.        $E9          New page
  197.        $EA          Group begin
  198.        $EB          Group end
  199.        $EC          Page header
  200.        $ED          Page footer
  201.        $EE          Skip lines         Byte  Count
  202.        $EF          Page number        Byte
  203.        $F0          Pause each page
  204.        $F1          Pause here
  205.        $F2          Set marker         Byte  Marker number
  206.        $F3          Page number        Byte  (add 256)
  207.        $F4          Page break         Byte  Page number
  208.        $F5          Page break         Byte  (add 256)
  209.        $F6          Page break         Byte  (break in middle of paragraph)
  210.        $F7          Page break         Byte  (add 256 in middle of paragraph)
  211.        $FF          End of file
  212.        ______________________________________________________________________
  213.  
  214.  
  215. Text Records
  216.  
  217. Text records are the lines where text has been typed.  The format is:
  218.  
  219. +000 to +001       Word     Number of bytes following this word.  
  220.                             Since the maximum is about 80, byte +001 
  221.                             is always zero.  Use byte +001 to identify 
  222.                             text lines.
  223. 3.0 +002                    If bit 7 is on, this line contains Tab and 
  224.                             Tab Filler special codes (described 
  225.                             below).  The remaining seven bits are the 
  226.                             screen column for the first text 
  227.                             character.  Usually will be zero, but may 
  228.                             vary as a result of left margin, 
  229.                             centering, and indent commands.
  230.                             If this byte is $FF, this text line is 
  231.                             actually a ruler--ASCII equivalent of what 
  232.                             appears on the top of the screen.
  233. +003               Byte     If bit 7 (the high bit) of this byte is 
  234.                             on, there is a carriage return on the end 
  235.                             of this line.  If off, no carriage return.
  236.                             Bits 6-0:  Number of bytes of text 
  237.                             following this byte.
  238. +004 to nnn                 Actual text bytes.  Consists of ASCII 
  239.                             characters and special codes.  The special 
  240.                             codes are values from $01 to $1F, and 
  241.                             indicate special formatting features:
  242.  
  243.                                    Code   Meaning
  244.                                    _________________________________
  245.                                    $01    Begin boldface
  246.                                    $02    Boldface end
  247.                                    $03    Superscript begin
  248.                                    $04    Superscript end
  249.                                    $05    Subscript begin
  250.                                    $06    Subscript end
  251.                                    $07    Underline begin
  252.                                    $08    Underline end
  253.                                    $09    Print page number
  254.                                    $0A    Enter keyboard
  255.                                    $0B    Sticky space
  256.                                    $0C    Begin Mail merge
  257.                             3.0    $0D    Reserved
  258.                             3.0    $0E    Print Date
  259.                             3.0    $0F    Print Time
  260.                             3.0    $10    Special Code 1
  261.                             3.0    $11    Special Code 2
  262.                             3.0    $12    Special Code 3
  263.                             3.0    $13    Special Code 4
  264.                             3.0    $14    Special Code 5
  265.                             3.0    $15    Special Code 6
  266.                             3.0    $16    Tab character
  267.                             3.0    $17    Tab fill character
  268.                                           (used in formatting lines)
  269.                             3.0    $18    Reserved
  270.                                    _________________________________
  271.  
  272.  
  273. File Tags
  274.  
  275. All AppleWorks files normally end with two bytes of $FF; tags are 
  276. anything after that.  Although File Tags were primarily designed by 
  277. Beagle Bros, they can be used by any application that needs to create or 
  278. modify an AppleWorks 3.0 file.
  279.  
  280. Because versions of AppleWorks before 3.0 stop at the double $FF, they 
  281. simply ignore tags.
  282.  
  283. The File Tag structure is as follows:
  284.  
  285. +000              Byte          Tag ID.  Should be $FF.
  286. +001              Byte          2nd ID byte.  These values will be 
  287.                                 defined and arbitrated by Beagle 
  288.                                 Bros Software.   Beagle may be 
  289.                                 reached at:
  290.  
  291.                                 Beagle Bros Inc
  292.                                 6215 Ferris Square, #100
  293.                                 San Diego, CA  92121
  294.  
  295. +002 to +003      Word          Data length.  If this is the last 
  296.                                 tag on the file, the low byte (+002) 
  297.                                 will be a count of the tags in this 
  298.                                 file, and the high byte (+003) will 
  299.                                 be $FF.
  300. +004 to nnn       Bytes         Actual tag data, immediately 
  301.                                 followed by the next four-byte tag 
  302.                                 ID.  These bytes do not exist for 
  303.                                 the last tag.
  304.  
  305. There is a maximum of 64 tags per file.  Each tag may be no larger than 
  306. 2K.
  307.  
  308. AppleWorks is a registered trademark of Apple Computer, Inc. licensed to 
  309. Claris Corporation.